eFAWATEERcom BANK API
Account Inquiry
URLs :
Description : This service allows the channel to make inquiries on customer accounts and returns all registered bills that are related to the Bills Payment module.
Channels that want to know detailed information about an Account will pass the Account inquiry request to the mule service, mule service will in turn call the eFAWATEERcom endpoint, get the account inquiry response and give that back to the channel. During processing, the request or response will not be stored in any layers within the mule.
Mulesoft Request:
Mandatory Headers: x-channel-id,x-client-trace-id, x-bank-id,client_id, client_secret
Optional Headers: x-sub-channel-id, x-user-id, Authorization, x-debug-flag, x-customer-id
Query Parameters:
| Field Name | Data Type | Required | Length | sample | Description |
|---|---|---|---|---|---|
| joebppsNo | Integer | C | Max 10 | 1234 | Represents unique identifier number of a customer |
| Either joebppsNo or (idType, id, nation) should be there | |||||
| idType | Enum, String | C | 3 fixed length | NAT | Represents a unique identifier type (The official number used to identify a customer) Enum: NAT PAS IQA BIS GOV NGO DPC |
| id | String | C | Max 20 | The identification of the customer based on the chosen value from the IdType field | |
| nation | Enum,String | C | 2 | JO | Represents the nationality of the Customer Enum: JO - Jordanian IQ - Iraq GB - British KW - Kuwait |
Request Body: NA
Mulesoft Response:
Success Response: (200)
Response Body: application/json
| Field Name | Type | Length | Occurrence | Description | Validation |
|---|---|---|---|---|---|
| status | Object | M | |||
| success | Boolean | M | true false | ||
| code | String | 10 | M | Error Code | “0” incase of success or Error Code |
| reasonCode | String | 50 | O | Error Type or Error category | Add this tag only incase of error |
| arabicMessage | String | 200 | M | English message translated to Arabic | تمت العملية بنجاح in case of success or arabic translated error in case of known errors |
| englishMessage | String | 200 | M | Description about the processing | “The Operation has been Successfully Completed” Or error Description |
| End of status | |||||
| response | Object | O | Exists if success = true | ||
| accountInquiry | Object | M | |||
| result | Object | M | |||
| errorCode | string | 3 | M | ||
| errorDesc | string | 100 | M | ||
| severity | string | 7 | M | Enum: Error, Info | |
| End result | |||||
| custId | Object | C | |||
| idType | Enum, String | 3 | M | Represents a unique identifier type (The official number used to identify a customer) | Enum: NAT PAS IQA BIS GOV NGO DPC |
| id | string | 20 | M | ||
| nation | Enum, String | 2 | M | Represents the nationality of the Customer | Enum: JO - Jordanian IQ - Iraq GB - British KW - Kuwait |
| name | string | 20 | O | ||
| phone | string | 20 | O | ||
| address | string | 100 | O | ||
| string | 100 | O | |||
| End of 'custId' | |||||
| joebppsNo | Integer | 10 | M | ||
| recCount | Integer | M | |||
| billingsRec | Object | C | Mandatory : if RecCount > 0 | ||
| billingRec | Array | M | repeatable | ||
| billerCode | Integer | 3 | M | ||
| billingNo | string | 50 | M | ||
| serviceType | string | 25 | M | ||
| billingStatus | Enum | 15 | M | Enum : Active Inactive | |
| nickName | string | 50 | O | ||
| End of billingRec | |||||
| End of billingsRec | |||||
| End of ‘ accountInquiry ‘ | |||||
| End of ‘ response ‘ |
{
"status": {
"success": true,
"code": "200",
"arabicMessage": "تمت العملية بنجاح",
"englishMessage": "The Operation has been Successfully Completed"
},
"response": {
"accountInquiry": {
"result": {
"errorCode": 0,
"errorDesc": "Success",
"severity": "Info"
},
"custId": {
"idType": "NAT",
"id": "9901001703",
"nation": "JO",
"name": "Ibrahim",
"phone": "+962786665356",
"address": "Amman",
"email": "ihamed@example.com"
},
"joebppsNo": 30,
"recCount": 2,
"billingsRec": {
"billingRec": [
{
"billerCode": 434,
"billingNo": "dhudfhg884",
"serviceType": "Internet",
"billingStatus": "Active",
"nickName": ""
},
{
"billerCode": 435,
"billingNo": "fdf4g884",
"serviceType": "Mobile",
"billingStatus": "Active",
"nickName": ""
}
]
}
}
}
}Sample Error Response:
Error codes :
500:
content-type: JSON
{
"success": false,
"code": "500",
"reasonCode": "InternalServerError",
"arabicMessage": "خطأ في الخادم الداخلي",
"englishMessage": "InvalidXMLSchema\nError : The 'Nation' element has an invalid value according to its data type. Location : Line No:17, Line Position:24"
}